Visual Cafe Pro Language Reference Method index | Bottom

Common methods

These methods are common to several classes.

Method Index

Top | Bottom
getAsciiStream
 o Returns a Projection value in a java.io.InputStream object in ASCII format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getAsciiStream( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getAsciiStream(int)
getAsciiStream(String)
getBignum
 o Returns a Projection value as a symjava.lang.Bignum object.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getBignum(int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getBignum(int, int)
getBignum(String, int)
getBinaryStream
 o Returns a Projection value in a java.io.InputStream object in binary format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getBinaryStream( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getBinaryStream(int)
getBinaryStream(String)
getBoolean
 o Returns a Projection value as a boolean.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getBoolean( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getBoolean(int)
getBoolean(String)
getByte
 o Returns a Projection value as a byte.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getByte( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getByte(int)
getByte(String)
getBytes
 o Returns a Projection value as an array of bytes.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getBytes( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getBytes(int)
getBytes(String)
getDate
 o Returns a Projection value as a symjava.sql.Date object.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getDate( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getDate(int)
getDate(String)
getDouble
 o Returns Projection value as a double.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getDouble( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getDouble(int)
getDouble(String)
getFloat
 o Returns Projection value as a float.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getFloat( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getFloat(int)
getFloat(String)
getInt
 o Returns a Projection value as an int.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getInt( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getInt(int)
getInt(String)
getLong
 o Returns a Projection value as a long.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getLong( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getLong(int)
getLong(String)
getMetaData( )
 o Returns a RelationViewMetaData object.
getShort
 o Returns a Projection value as a short.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getShort( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getShort(int)
getShort(String)
getString
 o Returns a Projection value as a String.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getString( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getString(int)
getString(String)
getStringValue
 o Returns a Projection value as a String in ASCII format.
 o Syntaxes for class symantec.itools.db.pro.ProjBinder:
getStringValue( )
getStringValue(int)
getStringValue(boolean)
getStringValue(int, boolean)
getStringValue(String, int)
getStringValue(int, int)
getStringValue(String, int, boolean)
getStringValue(int, int, boolean)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getStringValue(int)
getStringValue(int, int)
getStringValue(int, boolean)
getStringValue(int, int, boolean)
getStringValue(int, String, int)
getStringValue(int, int, int)
getStringValue(int, String, int, boolean)
getStringValue(int, int, int, boolean)
getTime
 o Returns a Projection value as a symjava.sql.Time object.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getTime( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getTime(int)
getTime(String)
getTimestamp
 o Returns a Projection value as a symjava.sql.Timestamp object.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getTimestamp( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getTimestamp(int)
getTimestamp(String)
getUnicodeStream
 o Returns a Projection value in a java.io.InputStream object in Unicode format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
getUnicodeStream( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
getUnicodeStream(int)
getUnicodeStream(String)
init
 o Initializes an object when you bind the object to a RelationView's projection.
isNull
 o Indicates whether or not a Projection value is defined.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
isNull( )
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
isNull(int)
isNull(String)
isReadable( )
 o Indicates whether or not a record can be read.
isWritable( )
 o Indicates whether or not a record can be written to.
notifyDataChange(ProjBinder)
 o Indicates that the current record's data for a ProjBinder's RelationView changed.
notifySetData(ProjBinder)
 o Indicates that the current record's data for a ProjBinder's RelationView changed.
setAsciiStream
 o Sets a Projection value to a java.io.InputStream object in ASCII format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setAsciiStream(InputStream, int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setAsciiStream(int, InputStream, int)
setAsciiStream(String, InputStream, int)
setBignum
 o Sets a Projection value to a symjava.lang.Bignum value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setBignum(Bignum)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setBignum(int, Bignum)
setBignum(String, Bignum)
setBinaryStream
 o Sets a Projection value to a java.io.InputStream object in binary format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setBinaryStream(InputStream, int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setBinaryStream(int, InputStream, int)
setBinaryStream(String, InputStream, int)
setBoolean
 o Sets a Projection value to a boolean value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setBoolean(boolean)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setBoolean(int, boolean)
setBoolean(String, boolean)
setByte
 o Sets a Projection value to a byte value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setByte(byte)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setByte(int, byte)
setByte(String, byte)
setBytes
 o Sets a Projection value to the values in an array of bytes.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setBytes(byte[ ])
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setBytes(int, byte[ ])
setBytes(String, byte[ ])
setDate
 o Sets a Projection value to a symjava.sql.Date value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setDate(Date)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setDate(int, Date)
setDate(String, Date)
setDouble
 o Sets a Projection value to a double value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setDouble(double)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setDouble(int, double)
setDouble(String, double)
setFloat
 o Sets a Projection value to a float value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setFloat(float)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setFloat(int, float)
setFloat(String, float)
setInt
 o Sets a Projection value to an int value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setInt(int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setInt(int, int)
setInt(String, int)
setLong
 o Sets a Projection value to a long value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setLong(long)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setLong(int, long)
setLong(String, long)
setNull
 o Sets a Projection value to NULL.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setNull(int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setNull(int, int)
setNull(String, int)
setShort
 o Sets a Projection value to a short value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setShort(short)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setShort(int, short)
setShort(String, short)
setString
 o Sets a Projection value to a String value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setString(String)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setString(int, String)
setString(String, String)
setTime
 o Sets a Projection value to a symjava.sql.Time value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setTime(Time)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setTime(int, Time)
setTime(String, Time)
setTimestamp
 o Sets a Projection value to a symjava.sql.Timestamp value.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setTimestamp(Timestamp)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setTimestamp(int, Timestamp)
setTimestamp(String, Timestamp)
setUnicodeStream
 o Sets a Projection value to a java.io.InputStream object in Unicode format.
 o Syntax for classes symantec.itools.db.pro.ProjBinder and symantec.itools.db.pro.Projection:
setUnicodeStream(InputStream, int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setUnicodeStream(int, InputStream, int)
setUnicodeStream(String, InputStream, int)
setValueFromString
 o Sets a Projection value to a String value.
 o Syntaxes for class symantec.itools.db.pro.ProjBinder:
setValueFromString(String)
setValueFromString(String, int)
setValueFromString(String, int, int)
setValueFromString(String, String, int)
setValueFromString(String, String, int, int)
setValueFromString(String, int, int, int)
 o Syntaxes for interface symantec.itools.db.pro.DataAccess and classes symantec.itools.db.pro.Record and symantec.itools.db.pro.RelationView:
setValueFromString(int, String)
setValueFromString(int, String, int)
setValueFromString(int, String, int, int)
setValueFromString(int, String, String, int)
setValueFromString(int, String, String, int, int)
setValueFromString(int, String, int, int, int)

Methods

Method index | Top | Bottom

Method: getAsciiStream

Purpose Returns a Projection value in a java.io.InputStream object in ASCII format.
Syntax For classes ProjBinder and Projection:
public abstract InputStream getAsciiStream( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract InputStream getAsciiStream(int proj) throws SQLException
public abstract InputStream getAsciiStream(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value in a java.io.InputStream object in ASCII format.
See also java.io.InputStream (in the Java API Documentation)

Method: getBignum

Purpose Returns a Projection value as a symjava.lang.Bignum object.
Syntax For classes ProjBinder and Projection:
public abstract Bignum getBignum(int scale) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract Bignum getBignum(int proj,
int scale) throws SQLException
public abstract Bignum getBignum(String projName,
int scale) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

scale = Number of digits of precision that are on the left side of the decimal point.

Description Returns a Projection value as a symjava.lang.Bignum object.
See also symjava.lang.Bignum (in the Java API Documentation)

Method: getBinaryStream

Purpose Returns a Projection value in a java.io.InputStream object in binary format.
Syntax For classes ProjBinder and Projection:
public abstract InputStream getBinaryStream( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract InputStream getBinaryStream(int proj) throws SQLException
public abstract InputStream getBinaryStream(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value in a java.io.InputStream object in binary format.
See also java.io.InputStream (in the Java API Documentation)

Method: getBoolean

Purpose Returns a Projection value as a boolean.
Syntax For classes ProjBinder and Projection:
public abstract boolean getBoolean( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract boolean getBoolean(int proj) throws SQLException
public abstract boolean getBoolean(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a boolean.

Method: getByte

Purpose Returns a Projection value as a byte.
Syntax For classes ProjBinder and Projection:
public abstract byte getByte( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract byte getByte(int proj) throws SQLException
public abstract byte getByte(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a byte.

Method: getBytes

Purpose Returns a Projection value as an array of bytes.
Syntax For classes ProjBinder and Projection:
public abstract byte[ ] getBytes( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract byte[ ] getBytes(int proj) throws SQLException
public abstract byte[ ] getBytes(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a zero-padded array of bytes. The array size is 1 to 255 bytes.

Method: getDate

Purpose Returns a Projection value as a symjava.sql.Date object.
Syntax For classes ProjBinder and Projection:
public abstract Date getDate( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract Date getDate(int proj) throws SQLException
public abstract Date getDate(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a symjava.sql.Date object.
See also symjava.sql.Date (in the JDBC Specification)

Method: getDouble

Purpose Returns a Projection value as a double.
Syntax For classes ProjBinder and Projection:
public abstract double getDouble( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract double getDouble(int proj) throws SQLException
public abstract double getDouble(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a double.

Method: getFloat

Purpose Returns a Projection value as a float.
Syntax For classes ProjBinder and Projection:
public abstract float getFloat( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract float getFloat(int proj) throws SQLException
public abstract float getFloat(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a float.

Method: getInt

Purpose Returns a Projection value as an int.
Syntax For classes ProjBinder and Projection:
public abstract int getInt( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract int getInt(int proj) throws SQLException
public abstract int getInt(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as an int.

Method: getLong

Purpose Returns a Projection value as a long.
Syntax For classes ProjBinder and Projection:
public abstract long getLong( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract long getLong(int proj) throws SQLException
public abstract long getLong(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a long.

Method: getMetaData

Purpose Returns a RelationViewMetaData object.
Syntax For classes Record and RelationView:
public RelationViewMetaData getMetaData( ) throws SQLException
Parameters None.
Description Returns a RelationViewMetaData object.
See also RelationViewMetaData

Method: getShort

Purpose Returns a Projection value as a short.
Syntax For classes ProjBinder and Projection:
public abstract short getShort( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract short getShort(int proj) throws SQLException
public abstract short getShort(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a short.

Method: getString

Purpose Returns a Projection value as a String.
Syntax For classes ProjBinder and Projection:
public abstract String getString( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract String getString(int proj) throws SQLException
public abstract String getString(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a space-padded String. The String can have up to 255 characters.

Method: getStringValue

Purpose Returns a Projection value as a String in ASCII format.
Syntax For class ProjBinder:
public String getStringValue( ) throws SQLException, IOException
public String getStringValue(int scale) throws SQLException, IOException
public String getStringValue(boolean processBinaryData) throws SQLException, IOException
public String getStringValue(int scale,
boolean processBinaryData) throws SQLException, IOException
public String getStringValue(String columnTypeName,
int scale) throws SQLException, IOException
public String getStringValue(int columnType,
int scale) throws SQLException, IOException
public String getStringValue(String columnTypeName,
int scale,
boolean processBinaryData) throws SQLException, IOException
public String getStringValue(int columnType,
int scale,
boolean processBinaryData) throws SQLException, IOException

For interface DataAccess and classes Record and RelationView:
public abstract String getStringValue(int proj) throws SQLException, IOException
public abstract String getStringValue(int proj,
int scale) throws SQLException, IOException
public abstract String getStringValue(int proj,
boolean processBinaryData) throws SQLException, IOException
public abstract String getStringValue(int proj,
int scale,
boolean processBinaryData) throws SQLException, IOException
public abstract String getStringValue(int proj,
String columnTypeName,
int scale) throws SQLException, IOException
public abstract String getStringValue(int proj,
int columnType,
int scale) throws SQLException, IOException
public abstract String getStringValue(int proj,
String columnTypeName,
int scale,
boolean processBinaryData) throws SQLException, IOException
public abstract String getStringValue(int proj,
int columnType,
int scale,
boolean processBinaryData) throws SQLException, IOException

Parameters proj = Projection ID for a column in a view traversing from left to right.

scale = Scale value for the getBignum and getBinary methods.

processBinaryData = Indicates whether or not to convert the return value to a String if it is a binary value.

columnTypeName = Value's data type.

columnType = Value's data type.

Description getStringValue returns a Projection value as a String in ASCII format by calling the appropriate getXXX method and converting the result to a String. This method does the following:
  1. Determines the Projection value to return as specified by the ProjBinder object or proj parameter.
  2. Determines the getXXX method to call. If the calling sequence includes columnTypeName or columnType, getStringValue uses the getXXX method indicated by that value.
  3. If the getXXX method is getBignum or getBinary, determines the scale. If the calling sequence includes the scale parameter, getStringValue uses that value.
  4. Calls the getXXX method.
  5. Converts the result to a String. If the result is a binary value and if the calling sequence includes processBinaryData, getStringValue uses processBinaryData to determine whether or not to convert the result to a String.
  6. Returns the Projection value.

Method: getTime

Purpose Returns a Projection value as a symjava.sql.Time object.
Syntax For classes ProjBinder and Projection:
public abstract Time getTime( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract Time getTime(int proj) throws SQLException
public abstract Time getTime(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a symjava.sql.Time object.
See also symjava.sql.Time (in the JDBC Specification)

Method: getTimestamp

Purpose Returns a Projection value as a symjava.sql.Timestamp object.
Syntax For classes ProjBinder and Projection:
public abstract Timestamp getTimestamp( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract Timestamp getTimestamp(int proj) throws SQLException
public abstract Timestamp getTimestamp(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value as a symjava.sql.Timestamp object.
See also symjava.sql.Timestamp (in the JDBC Specification)

Method: getUnicodeStream

Purpose Returns a Projection value in a java.io.InputStream object in Unicode format.
Syntax For classes ProjBinder and Projection:
public abstract InputStream getUnicodeStream( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract InputStream getUnicodeStream(int proj) throws SQLException
public abstract InputStream getUnicodeStream(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Returns a Projection value in a java.io.InputStream object in Unicode format. Unicode format is useful for international applications.
See also java.io.InputStream (in the Java API Documentation)

Method: init

Purpose Initializes an object when you bind the object to a RelationView's projection.
Syntax For classes Projection and ProjLink:
public abstract void init(ProjBinder data)
Parameters data = ProjBinder object.
Description Initializes an object when you bind the object to a RelationView's projection. The object needs to track the ProjBinder object to notify the dbANYWHERE Server when the object changes its data.
See also ProjBinder

Method: isNull

Purpose Indicates whether or not a Projection value is defined.
Syntax For classes ProjBinder and Projection:
public abstract boolean isNull( ) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract boolean isNull(int proj) throws SQLException
public abstract boolean isNull(String projName) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

Description Indicates whether or not a Projection value is defined.
Returns True = The Projection value is defined.

False = The Projection value is not defined.


Method: isReadable

Purpose Indicates whether or not a record can be read.
Syntax public boolean isReadable( ) throws SQLException
Parameters None.
Description Indicates whether or not a record can be read.
Returns True = The record is in a readable state.

False = The record is not in a readable state.


Method: isWritable

Purpose Indicates whether or not a record can be written to.
Syntax public boolean isWritable( ) throws SQLException
Parameters None.
Description Indicates whether or not a record can be written to.
Returns True = The record is in a writable state.

False = The record is not in a writable state.


Method: notifyDataChange

Purpose Indicates that the current record's data for a ProjBinder's RelationView changed.
Syntax For class Projection:
public void notifyDataChange(ProjBinder data)
For interface ProjLink:
public abstract void notifyDataChange(ProjBinder data)
Parameters data = Object for notifying the dbANYWHERE server of persistent data changes.
Description Indicates that the current record's data for a ProjBinder's RelationView changed. Use the ProjBinder object to retrieve the new data.
See also ProjBinder

Method: notifySetData

Purpose Indicates that the current record's data for a ProjBinder's RelationView changed.
Syntax For class Projection:
public boolean notifySetData(ProjBinder data) throws SQLException

For interface ProjLink:
public abstract boolean notifySetData(ProjBinder data) throws SQLException

Parameters data = Object for notifying the dbANYWHERE server of persistent data changes.
Description Indicates that the current record's data for a ProjBinder's RelationView changed. Use the ProjBinder object to set new data. Return values: True = success; False = failure.

Method: setAsciiStream

Purpose Sets a Projection value to a java.io.InputStream object in ASCII format.
Syntax For classes ProjBinder and Projection:
public abstract void setAsciiStream(InputStream x,
int length) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setAsciiStream(int proj,
InputStream x,
int length) throws SQLException
public abstract void setAsciiStream(String projName,
InputStream x,
int length) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input stream.

length = Length of x in bytes.

Description Sets a Projection value to a java.io.InputStream object in ASCII format.
See also java.io.InputStream (in the Java API Documentation)

Method: setBignum

Purpose Sets a Projection value to a symjava.lang.Bignum value.
Syntax For classes ProjBinder and Projection:
public abstract void setBignum(Bignum x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBignum(int proj,
Bignum x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBignum(String projName,
Bignum x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a symjava.lang.Bignum value.
See also symjava.lang.Bignum (in the JDBC Specification)

Method: setBinaryStream

Purpose Sets a Projection value to a java.io.InputStream object in binary format.
Syntax For classes ProjBinder and Projection:
public abstract void setBinaryStream(InputStream x,
int length) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBinaryStream(int proj,
InputStream x,
int length) throws SQLException
public abstract void setBinaryStream(String projName,
InputStream x,
int length) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input stream.

length = Length of x in bytes.

Description Sets a Projection value to a java.io.InputStream object in binary format.
See also java.io.InputStream (in the Java API Documentation)

Method: setBoolean

Purpose Sets a Projection value to a boolean value.
Syntax For classes ProjBinder and Projection:
public abstract void setBoolean(boolean x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBoolean(int proj,
boolean x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBoolean(String projName,
boolean x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a boolean value.

Method: setByte

Purpose Sets a Projection value to a byte value.
Syntax For classes ProjBinder and Projection:
public abstract void setByte(byte x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setByte(int proj,
byte x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setByte(String projName,
byte x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a byte value.

Method: setBytes

Purpose Sets a Projection value to the values in an array of bytes.
Syntax For classes ProjBinder and Projection:
public abstract void setBytes(byte[ ] x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBytes(int proj,
byte[ ] x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setBytes(String projName,
byte[ ] x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value. The array size is 1 to 255 bytes and must be zero-padded.

Description Sets a Projection value to the values in an array of bytes.

Method: setDate

Purpose Sets a Projection value to a symjava.sql.Date value.
Syntax For classes ProjBinder and Projection:
public abstract void setDate(Date x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setDate(int proj,
Date x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setDate(String projName,
Date x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to symjava.sql.Date value.
See also symjava.sql.Date (in the JDBC Specification)

Method: setDouble

Purpose Sets a Projection value to a double value.
Syntax For classes ProjBinder and Projection:
public abstract void setDouble(double x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setDouble(int proj,
double x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setDouble(String projName,
double x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a double value.

Method: setFloat

Purpose Sets a Projection value to a float value.
Syntax For classes ProjBinder and Projection:
public abstract void setFloat(float x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setFloat(int proj,
float x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setFloat(String projName,
float x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a float value.

Method: setInt

Purpose Sets a Projection value to an int value.
Syntax For classes ProjBinder and Projection:
public abstract void setInt(int x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setInt(int proj,
int x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setInt(String projName,
int x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to an int value.

Method: setLong

Purpose Sets a Projection value to a long value.
Syntax For classes ProjBinder and Projection:
public abstract void setLong(long x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setLong(int proj,
long x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setLong(String projName,
long x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a long value.

Method: setNull

Purpose Sets a Projection value to NULL.
Syntax For classes ProjBinder and Projection:
public abstract void setNull(int sqlType) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setNull(int proj,
int sqlType) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setNull(String projName,
int sqlType) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

sqlType = Data type of the Projection value.

Description Sets a Projection value to NULL.

Method: setShort

Purpose Sets a Projection value to a short value.
Syntax For classes ProjBinder and Projection:
public abstract void setShort(short x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setShort(int proj,
short x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setShort(String projName,
short x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a short value.

Method: setString

Purpose Sets a Projection value to a String value.
Syntax For classes ProjBinder and Projection:
public abstract void setString(String x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setString(int proj,
String x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setString(String projName,
String x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value. The String must be space-padded and can have up to 255 characters.

Description Sets a Projection value to a String value.

Method: setTime

Purpose Sets a Projection value to a symjava.sql.Time value.
Syntax For classes ProjBinder and Projection:
public abstract void setTime(Time x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setTime(int proj,
Time x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setTime(String projName,
Time x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to symjava.sql.Time value.
See also symjava.sql.Time (in the JDBC Specification)

Method: setTimestamp

Purpose Sets a Projection value to a symjava.sql.Timestamp value.
Syntax For classes ProjBinder and Projection:
public abstract void setTimestamp(Timestamp x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setTimestamp(int proj,
Timestamp x) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setTimestamp(String projName,
Timestamp x) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input value for the Projection value.

Description Sets a Projection value to a symjava.sql.Timestamp value.
See also symjava.sql.Timestamp (in the JDBC Specification)

Method: setUnicodeStream

Purpose Sets a Projection value to a java.io.InputStream object in Unicode format.
Syntax For classes ProjBinder and Projection:
public abstract void setUnicodeStream(InputStream x,
int length) throws SQLException

For interface DataAccess and classes Record and RelationView:
public abstract void setUnicodeStream(int proj,
InputStream x,
int length) throws SQLException
public abstract void setUnicodeStream(String projName,
InputStream x,
int length) throws SQLException

Parameters proj = Projection ID for a column in a view traversing from left to right.

projName = Projection name for a column in a view traversing from left to right.

x = Input stream.

length = Length of x in bytes.

Description Sets a Projection value to a java.io.InputStream object in Unicode format. Unicode format is useful for international applications.
See also java.io.InputStream (in the Java API Documentation)

Method: setValueFromString

Purpose Sets a Projection value to a String value.
Syntax For class ProjBinder:
public abstract void setValueFromString(String data) throws SQLException, IOException

public abstract void setValueFromString(String data,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(String data,
int scale,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(String data,
String columnTypeName,
int scale) throws SQLException, IOException

public abstract void setValueFromString(String data,
String columnTypeName,
int scale,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(String data,
String columnType,
int scale,
int treatBlankAsNull) throws SQLException, IOException

For interface DataAccess and classes Record and RelationView:
public abstract void setValueFromString(int proj,
String data) throws SQLException, IOException

public abstract void setValueFromString(int proj,
String data,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(int proj,
String data,
int scale,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(int proj,
String data,
String columnTypeName,
int scale) throws SQLException, IOException

public abstract void setValueFromString(int proj,
String data,
String columnTypeName,
int scale,
int treatBlankAsNull) throws SQLException, IOException

public abstract void setValueFromString(int proj,
String data,
String columnType,
int scale,
int treatBlankAsNull) throws SQLException, IOException

Parameters proj = Projection ID for a column in a view traversing from left to right.

data = Input value for the Projection value.

scale = Scale value for the getBignum method.

treatBlankAsNull = Indicates whether or not to convert the input value to NULL if it is an empty String.

columnTypeName = Value's data type.

columnType = Value's data type.

Description setValueFromString sets a Projection value to a String value by converting the input value to a String and calling the appropriate setXXX method. This method does the following:
  1. Converts the input value to a String. If the input value is an empty string and if the calling sequence includes treatBlankAsNull, setValueFromString uses treatBlankAsNull to determine whether or not to convert the empty string to NULL.
  2. Determines the Projection value to set as specified by the ProjBinder object or proj parameter.
  3. Determines the setXXX method to call. If the calling sequence includes columnTypeName or columnType, setValueFromString uses the setXXX method indicated by that value.
  4. If the setXXX method is setBignum, determines the scale. If the calling sequence includes the scale parameter, setValueFromString uses that value.
  5. Calls the setXXX method.

Method index | Top

Copyright © 1996 Symantec Corporation. All rights reserved.